Introduction
Welcome to the Alaunus API! You can use our API to access Alaunus API endpoints, which can get information on stuff in our database.
We have language bindings in Shell, Ruby, and Python! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.
Authentication
To authorize, use this code:
require 'Kittn'
api = Kittn::APIClient.authorize!('meowmeowmeow')
import kittn
api = kittn.authorize('meowmeowmeow')
# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
-H "Authorization: meowmeowmeow"
const kittn = require('kittn');
let api = kittn.authorize('meowmeowmeow');
Make sure to replace
meowmeowmeowwith your API key.
Kittn uses API keys to allow access to the API. You can register a new Kittn API key at our developer portal.
Kittn expects for the API key to be included in all API requests to the server in a header that looks like the following:
Authorization: meowmeowmeow
Accounts
The accounts object
Attributes:
Attribute
Description
This contains the created date
This contains the account id number
active
integer
integer
If the account is active or not
billing_settings
subdocument
subdocument
Contains all the billing settings, like how is the billing going to happen, what happens with late checkouts and others
candidate_settings
subdocument
subdocument
Contains all information on employee candidates, like stage, description, hr information and more
email
string
string
Retrieves the email data
emergency_phones
subdocuments
subdocuments
Contains the emergency phones and its informations
ext_id
string
string
Contains the external id
hst_number
string
string
Contains the HST number
invoice_settings
subdocument
subdocument
Contains all the invoice settings, like the sales rep for example.
locations
subdocuments
subdocuments
Location info, like address and geolocation
logo
file
file
Company logo
name
subdocument
subdocument
Name of the company
payroll_settings
subdocument
subdocument
Contains all the payroll settings, like the type of payroll, the period and others
policy
file
file
The company's policy
role_settings
subdocument
subdocument
This contains the settings for each role inside the company
roles
subdocuments
subdocuments
Contains information about the roles, like for example the type, color and all the permissions
sales_reps
subdocuments
subdocuments
Contains information on the sales reps, like his or hers name, office, nickname and others
scheduler_settings
subdocument
subdocument
Contains all the scheduler settings, like duration and permissions for example
services
subdocuments
subdocuments
Contains the services and its informations, like its code, description, pay rate and others
settings
subdocument
subdocument
Contains settings like the timezone, currency used, country, language and others
taxes
subdocuments
subdocuments
Contains the taxes info, like the amount and its label
telephony
subdocument
subdocument
Contains the telephony information, like the authentication token, errors and others
terms
subdocuments
subdocuments
Contains the company's terms
visit_settings
subdocument
subdocument
Contains all the visit settings, like punchcards, gps, overrides and telephony
website
string
string
Contains the company's website
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Candidates
The candidates object
Attributes:
Attribute
Description
_deleted_dates
subdocuments
subdocuments
Contains the date in which the candidate was deleted and its reasons
_hired
boolean
boolean
If candidate was hired or not
_hired_date
datetime
datetime
Date in which the candidate was hired
_hired_user
id
id
User that hired
availability
subdocument
subdocument
What are the days and hours that the candidate is available during the week
candidate_notes
subdocuments
subdocuments
Notes on the candidate
What is the status of the candidate, applied, phone screened, selected for interview, interviewd or hired
certifications
subdocuments
subdocuments
What are the certifications of the candidate
How are the cleaning skills of the candidate
How are the cooking skills of the candidate
cover_letter
string
string
Candidate's cover letter
criminal_offender
boolean
boolean
If the candidate was a criminal offender
criminal_offender_reason
string
string
In case the candidate was a criminal offender, what was the reason
date_of_birth
date
date
Contains the date of birth of the candidate
Contains information on the candidate's drivers licence, if the candidate has one or not and others
This contains the level of education of the candidate
email
string
string
Contains the email of the candidate
employment_history
subdocuments
subdocuments
This contains the employment history of the candidate, previous jobs, duration and etc
How many years of experiece the candidate has
experience_with_ages
subdocument
subdocument
Information on which range of ages the candidate has experience with
ext_id
string
string
Contains the external id
gender
id
id
Contains the gender of the candidate
has_pets
boolean
boolean
If the candidate is okay with pets
is_smoker
boolean
boolean
If the candidate is okay with smokers
languages
subdocuments
subdocuments
Contains the languages spoken by the candidate and which one is the primary language
Living status of the candidate
locations
subdocuments
subdocuments
Location info, like address and geolocation
manager
id
id
Manager info
name
subdocument
subdocument
Name of the candidate
nearest_intersection
string
string
The nearest intersection to the candidate
phones
subdocuments
subdocuments
Information on the candidate's phones, like numbers and types
rating
integer
integer
Contains the rating on the candidate
resume
string
string
Candidate's resume
salary_expectations
subdocument
subdocument
What are the salary expectations of the candidate
skills
subdocuments
subdocuments
What are the candidate's skills
source
id
id
Candidate's source
How are the swimming skills of the candidate
Contains the method of transportation of the candidate, if it is by bus or car for example
travel_passport
boolean
boolean
If the candidate has a valid travel passport or not
type_of_pets
id
id
If the candidate is okay with pets, which kind of pets
us_visa
boolean
boolean
If the candidate has a US travel visa or not
will_travel
boolean
boolean
If the candidate is willing to travel or not
work_permit
id
id
What is the type of work permit of the candidate
work_status
subdocument
subdocument
Contains information on the candidate work status, if it is full time, part time, temp or on call
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Clients
The clients object
Attributes:
Attribute
Description
accounting_id
string
string
Contains the accounting id
color
string
string
Color of the tag
company
subdocument
subdocument
Company's name and website
contact
subdocument
subdocument
Information on the client, like name, phones and gender
contact_type
id
id
Type of client, if it is company or person
email
string
string
Contains the email of the client
employees
subdocuments
subdocuments
Contains information on the employees, like their names, offices, emails and others
ext_id
string
string
Contains the external id
locations
subdocuments
subdocuments
Location info, like address and geolocation
type
id
id
Type of client, if it is company or person
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Contacts
The contacts object
Attributes:
Attribute
Description
_type
id
id
Type of contact, if it is company or person
accounting_id
string
string
Contains the accounting id
company
subdocument
subdocument
Company's name and website
contact
subdocument
subdocument
Information on the client, like name, phones and gender
email
string
string
Contains the email of the contact
ext_id
string
string
Contains the external id
fax
subdocument
subdocument
Contains the fax number of the contact
locations
subdocuments
subdocuments
Location info, like address and geolocation
notes
string
string
Notes on the contact
photo
file
file
Photo of the contact
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Conversations
The conversations object
Attributes:
Attribute
Description
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Events
The events object
Attributes:
Attribute
Description
Information on the user that created this event
_group
id
id
Group of events
_last_updated_date
datetime
datetime
When was the event last updated
Which user last updated the event
attendees
subdocuments
subdocuments
Information on who are the attendees on the event, like name, pay_rate and others
billing
subdocument
subdocument
Information on the billing, like billing period, currency, payment method and others
duration
float
float
Information on the duration of the event
end
datetime
datetime
When does the event ends
expectation
subdocument
subdocument
Expectation on the bill amount
location
subdocument
subdocument
Location where the event is going to start with information like address and geolocation
location_end
subdocument
subdocument
Location where the event is going to end with information like address and geolocation
notes
string
string
Notes on the event
patient
subdocument
subdocument
Information on the patient
service
subdocument
subdocument
Information on the services that apply for this event, like pay rate and others
start
datetime
datetime
Start of the event
stat_holiday
boolean
boolean
If it was on a holiday
status
id
id
Status of the event
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Eventsgroups
The eventsgroups object
Attributes:
Attribute
Description
bymonthday
array
array
If the event is grouped by month
byweekday
array
array
If the event is grouped by week
count
integer
integer
How many times the event happens
dtstart
date
date
Date the event group started
end
datetime
datetime
Dante the event group ends
ends
subdocument
subdocument
The ends of the event
events
array
array
All the events in that group of events
freq
string
string
The frequency in which the event repeats
interval
integer
integer
The interval in which the event happens
start
datetime
datetime
When the group of events start
until
datetime
datetime
Until when the group of events is supposed to happen
wkst
string
string
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Files
The files object
Attributes:
Attribute
Description
_uploaded_date
datetime
datetime
Date in which the file was uploaded
checksum
string
string
Checksum number in order to detect errors on the file
content_type
string
string
Type of the content of the file
file
string
string
The file
name
string
string
Name of the file
notes
string
string
Notes on the file
type
id
id
Type of the file
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Invoices
The invoices object
Attributes:
Attribute
Description
_closed
boolean
boolean
If the invoice is closed or not
_closed_date
datetime
datetime
Date in which the invoice was closed in case it was closed
_closed_user
id
id
User that closed the invoice
account
subdocument
subdocument
Information on the account, like name, location and website
amount_due
float
float
How much is due to be paid
amount_paid
float
float
How much was paid
billing_period
subdocument
subdocument
What is the billing period
Date in which the billing period ends
Date in which the billing period starts
cc_invoice
subdocument
subdocument
Credit card invoice
claim_number
string
string
Contains the number of the claim
client
subdocument
subdocument
Information on the client, like for example type, id, email, phone and others
currency
id
id
Currency used
due_date
date
date
When it is due
footer_message
string
string
Message on the footer
from_email
string
string
Email used for the invoice
header_message
string
string
Message on the header
hst_number
string
string
Contains the HST number
invoice_date
date
date
Date of the invoice
invoice_type
id
id
Type of the invoice
legal_rep
string
string
Information on the legal rep
loss_date
date
date
Date of loss
method
id
id
Method used for the invoice
notes
string
string
Notes on the invoice
number
string
string
Invoice number
patient
subdocument
subdocument
Information on the patient, with email, name, location, phone and others
Method used for the payment
punchcards
subdocuments
subdocuments
Punchcards information, with bill and others
referred_by
subdocument
subdocument
By whom it was referred
sales_rep
subdocument
subdocument
Contains information on the sales rep, like his or hers name, office, nickname and others
services
subdocuments
subdocuments
Contains the services and its informations, like its code, description, pay rate and others
status
id
id
Status of the invoice
subtotal
float
float
Invoice's subtotal
tax_total
float
float
Total taxes
taxes
subdocuments
subdocuments
Contains the taxes info, like the amount and its label
template
id
id
Invoice template
term
subdocument
subdocument
Invoice's term
total
float
float
Invoice's total
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Patients
The patients object
Attributes:
Attribute
Description
_account
id
id
_deleted_dates
subdocuments
subdocuments
Contains the date in which the patient was deleted and its reasons
accounting_id
string
string
Contains the accounting id
billing
subdocuments
subdocuments
Contains all the billing info, like how is the billing period and others
Information on the case coordinator for that patient
ccac
subdocument
subdocument
Credit card account of the patient
chart_id
string
string
Patient's chart ID
checklist
subdocument
subdocument
Patient's checklist
What are the cleaning skills the patient is expecting
contacts
subdocuments
subdocuments
Emergency contacts with phone number and etc
What are the cooking skills the patient is expecting
date_of_birth
date
date
Date of birth of the patient
This contains the level of education the patient expects
email
string
string
Contains the email of the patient
ethnicity
id
id
Ethnicity of the patient
Number of years of experience expected by the patient
experience_with_ages
subdocument
subdocument
Experience with range of years expected
files
subdocuments
subdocuments
Files about the patient
gender
id
id
Gender of the patient
general_notes
string
string
Notes on the patient
has_pets
boolean
boolean
If the patient has pets
important_notes
string
string
Notes on the patient
is_smoker
boolean
boolean
If the patient is a smoker
languages
subdocuments
subdocuments
Languages spoken by the patient
legal_rep
string
string
Information on the legal rep
Living status of the patient
locations
subdocuments
subdocuments
Location info, like address and geolocation
major_intersection
string
string
The major intersection to the candidate
Marital status of the patient
name
subdocument
subdocument
Name of the patient
notes
subdocuments
subdocuments
Notes on the patient
phones
subdocuments
subdocuments
All patient's phone numbers and its types
photo
file
file
Photo of the patient
problems
subdocuments
subdocuments
Patient's problems
referred_by
id
id
Who referred that patient
religion
id
id
Patient's religion
salary_expectations
subdocument
subdocument
How much is the salary
service_date
subdocument
subdocument
Service date range
services
subdocuments
subdocuments
All the services necessary by the patient
ssn
string
string
SSN nuber
ssn_expiry_date
date
date
Date in which the ssn expiry
status
id
id
Patient's status
What are the swimming skills the patient is expecting
What kind of transportation is the patient expecting
travel_passport
boolean
boolean
If patient requires a valid travel passport
type_of_pets
id
id
If the patient has pets, what are the kind of pets
us_visa
boolean
boolean
If patient requires a valid US visa
Education level required by the patient
will_travel
boolean
boolean
If patient will be travelling
work_status
subdocument
subdocument
Work status required by tge patient
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Patientsprogressnotes
The patientsprogressnotes object
Attributes:
Attribute
Description
Date in which the progress note was created
Which user created the progress note
If it was deleted
_last_updated_date
datetime
datetime
Last date note was updated
Last user that updated the note
approval
subdocument
subdocument
If it was approved and the date
invoice_to
subdocument
subdocument
For whom is the invoice
note
string
string
The note itself
patient
id
id
Patient ID
Patient's services
priority
id
id
The priority of the note
private
boolean
boolean
If the note is private or not
referrer
id
id
Who referred
service
id
id
The service that was tagged
tags
subdocuments
subdocuments
Tags of the note
title
string
string
The title of the note
users
subdocuments
subdocuments
Tagged users on the note
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Payments
The payments object
Attributes:
Attribute
Description
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Payrolls
The payrolls object
Attributes:
Attribute
Description
_closed
boolean
boolean
If payroll was closed or not
_closed_date
datetime
datetime
Date when payroll was closed
_closed_user
id
id
User that closed the payroll
end
date
date
End date
period_extra
integer
integer
Extra period
period_type
id
id
Type of the period
start
date
date
Start date
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Payrollsusers
The payrollsusers object
Attributes:
Attribute
Description
The date it was created
The user that created it
adjustments
subdocuments
subdocuments
ADjustments information
payroll
id
id
Payroll information
punchcards
array
array
Punchcards information, with bill and others
user
subdocument
subdocument
User information, like name, nickname and others
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Punchcards
The punchcards object
Attributes:
Attribute
Description
_event
subdocument
subdocument
Punchcard's event
actual
subdocument
subdocument
Actual information, with actual date and others
bill
subdocument
subdocument
Punchcard's bill
billing
subdocument
subdocument
All billing info on the punchcards
event
id
id
Punchcard's event ID
invoice
subdocument
subdocument
Punchcard's invoice
location
subdocument
subdocument
Punchcard's location
location_end
subdocument
subdocument
The end location for that punchcard
patient
subdocument
subdocument
Patient on the punchcard
pay
subdocument
subdocument
All the paying information on that punchcard
payroll
subdocument
subdocument
Payroll on the punchcard
service
subdocument
subdocument
Information about the service on that punchcard
stat_holiday
boolean
boolean
If it is or not an statutory holiday
user
subdocument
subdocument
The user on that punchcard and his or hers information
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Skills
The skills object
Attributes:
Attribute
Description
color
string
string
Color of the skill
description
string
string
Description of the skill
title
string
string
Title of the skill
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Tags
The tags object
Attributes:
Attribute
Description
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Users
The users object
Attributes:
Attribute
Description
_candidate
id
id
Contains the candidate id
User was deleted
_deleted_dates
subdocuments
subdocuments
Contains the date in which the user was deleted and its reasons
_setup_date
datetime
datetime
Date in which the user was set
_suspended
boolean
boolean
User was suspended
_suspended_date
datetime
datetime
Contains the date in which the user was suspended
Who suspended that user
accounting_id
string
string
This contains the accounting id number
availability
subdocument
subdocument
Days and hours in which the user is available
certifications
subdocuments
subdocuments
Certifications of the user, like school, university and etc
How are the cleaning skills of the user
How are the cooking skills of the user
criminal_offender
boolean
boolean
If the user was a criminal offender
criminal_offender_reason
string
string
In case the user was a criminal offender, what was the reason
date_of_birth
date
date
Date of birth of the user
Contains information on the user's drivers licence, if the user has one or not and others
This contains the level of education of the user
email
string
string
Contains the user email
employment_history
subdocuments
subdocuments
This contains the employment history of the user, previous jobs, duration and etc
How many years of experiece the user has
experience_with_ages
subdocument
subdocument
Information on which range of ages the user has experience with
ext_id
string
string
Contains the user external ID
files
subdocuments
subdocuments
Any files on the user
gender
id
id
User's gender
has_pets
boolean
boolean
If the user is okay with pets
invited_date
datetime
datetime
Date in which the user was invited
is_setup
boolean
boolean
If the user is set up
is_smoker
boolean
boolean
If the user is okay with smokers
languages
subdocuments
subdocuments
Languages spoken by the user, with information on which one is his or hers primary language
last_login_date
datetime
datetime
Last time user logged in
Living status of the user
locations
subdocuments
subdocuments
Location info, like address and geolocation
manager
id
id
Manager info
name
subdocument
subdocument
Name of the user
nearest_intersection
string
string
The nearest intersection to the user
phones
subdocuments
subdocuments
Information on the user's phones, like numbers and types
photo
file
file
User's photo
role
id
id
Role of the user
role_type
id
id
Type of role
salary_expectations
subdocument
subdocument
What are the salary expectations of the user
services
subdocuments
subdocuments
Services provided by the user
skills
subdocuments
subdocuments
What are the user's skills
source
id
id
User's source
ssn
string
string
SSN number
ssn_expiry_date
date
date
SSN expiry date
start_date
date
date
Date in which the user started
How are the swimming skills of the user
timezone
id
id
Timezone of the user
Contains the method of transportation of the user, if it is by bus or car for example
travel_passport
boolean
boolean
If the user has a valid travel passport or not
type_of_pets
id
id
If the user is okay with pets, which kind of pets
us_visa
boolean
boolean
If the user has a US travel visa or not
will_travel
boolean
boolean
If the user is willing to travel or not
work_permit
id
id
What is the type of work permit of the user
work_status
subdocument
subdocument
Contains information on the user work status, if it is full time, part time, temp or on call
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Usersnotes
The usersnotes object
Attributes:
Attribute
Description
Date in which the note was created
Which user created the note
If it was deleted
last_updated_date
datetime
datetime
Last date note was updated
Last user that updated the note
note
string
string
The note itself
priority
id
id
The priority of the note
title
string
string
The title of the note
user
id
id
User ID
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'